Publish man pages to /man/ #14
Conversation
WhyNotHugo
force-pushed
the
man2html
branch
from
b031db9
to
cec9d00
Compare
|
Failure is due to CI trying to publish the site without permission. |
Fixed in 087bb5b |
| oauth: pages.sr.ht/PAGES:RW | ||
| sources: | ||
| - https://github.com/swaywm/swaywm.org | ||
| packages: | ||
| - hut | ||
| - mandoc | ||
| - sway-doc |
There was a problem hiding this comment.
I wonder if we should clone the sway repo instead and run scdoc, to grab the latest version even if the package is lagging or something?
Downsides: would need to checkout the latest tag to avoid publishing docs for unreleased versions, and would need to hardcode man pages paths.
There was a problem hiding this comment.
I think that's more effort that it's worth. The sway-docs package on alpine/edge should not take more than a day or two to update, and this saves us having to build all of sway.
Maybe if sway had some mechanism to instruct meson to only build docs?
There was a problem hiding this comment.
I think that's more effort that it's worth. The sway-docs package on alpine/edge should not take more than a day or two to update, and this saves us having to build all of sway.
Not a fan on relying on a distro to just build a man page, but I can live with that…
Maybe if sway had some mechanism to instruct meson to only build docs?
One way would be to invoke scdoc directly. Another would be to pass the list of man pages to ninja (ninja -C build/ sway.1 …), but we'd still need to pull all sway build deps.
There was a problem hiding this comment.
TBH, I can also just fetch the sway repo, find pages with find . -name '*.scd' and then run scdoc on them individually. Should be quite doable in a single sh script.
|
Thanks for the PR! Overall looks pretty good. |
WhyNotHugo
force-pushed
the
man2html
branch
from
cec9d00
to
4060ec1
Compare
|
(BTW, needs a rebase) |
WhyNotHugo
force-pushed
the
man2html
branch
3 times, most recently
from
2d40b73
to
c8d816f
Compare
|
Updated and rebased |
|
Alright, let's just go with that approach for now. We can always change later on to something else. Here's a sed command to linkify references inside man pages, should make it easier to navigate: Also we should probably add a new link on the homepage linking to the man pages? Should we just link to sway(1), or sway(5), or to an HTML page listing all man pages? |
We'd still need to link these in the index page.
I used the pages from the latest stable release from alpine/edge. This is a lot simpler/faster than cloning the sway repository and building the whole project.